jsdoc-api
Advanced tools
Package description
The jsdoc-api npm package provides a programmatic interface to JSDoc, allowing you to generate documentation from JavaScript source code comments. It can be used to parse JSDoc comments and generate JSON output, making it easier to integrate JSDoc functionality into build processes or other tools.
Generate Documentation
This feature allows you to generate documentation from JavaScript files. The `renderSync` method processes the specified files and generates the documentation.
const jsdoc = require('jsdoc-api');
jsdoc.renderSync({
files: 'path/to/your/file.js'
});Parse JSDoc Comments
This feature allows you to parse JSDoc comments from a source string. The `explainSync` method returns a JSON representation of the parsed comments.
const jsdoc = require('jsdoc-api');
const docs = jsdoc.explainSync({
source: '/**
* A description of the function.
* @param {string} name - The name of the person.
* @returns {string} A greeting message.
*/
function greet(name) {
return `Hello, ${name}!`;
}'
});
console.log(docs);Configure JSDoc Options
This feature allows you to use a configuration file to customize the JSDoc generation process. The `configure` option specifies the path to a JSDoc configuration file.
const jsdoc = require('jsdoc-api');
const docs = jsdoc.explainSync({
files: 'path/to/your/file.js',
configure: 'path/to/jsdoc.conf.json'
});
console.log(docs);The `documentation` package is another tool for generating documentation from JavaScript comments. It offers a command-line interface and programmatic API, similar to jsdoc-api. It supports ES6+ syntax and can output documentation in various formats, including HTML and Markdown.
The `esdoc` package is designed specifically for ES6+ JavaScript. It provides a comprehensive documentation generation tool with support for various plugins and themes. Compared to jsdoc-api, esdoc offers more modern syntax support and additional customization options.
The `typedoc` package is a documentation generator for TypeScript projects. It generates documentation based on TypeScript type annotations and comments. While jsdoc-api focuses on JavaScript, typedoc is tailored for TypeScript, providing better integration with TypeScript's type system.
Readme
A programmatic interface for jsdoc3 with a few features:
> const jsdoc = require('jsdoc-api')
> jsdoc.explainSync({ source: '/** example doclet */ \n var example = true' })
[ { comment: '/** example doclet *∕',
meta:
{ range: [ 28, 42 ],
filename: 'nkrf18zlymohia4i29a0zkyt84obt9.js',
lineno: 2,
path: '/var/folders/74/tqh7thm11tq72d7sjty9qvdh0000gn/T',
code:
{ id: 'astnode100000002',
name: 'example',
type: 'Literal',
value: true } },
description: 'example doclet',
name: 'example',
longname: 'example',
kind: 'member',
scope: 'global' },
{ kind: 'package',
longname: 'package:undefined',
files: [ '/var/folders/74/tqh7thm11tq72d7sjty9qvdh0000gn/T/nkrf18zlymohia4i29a0zkyt84obt9.js' ] } ]
cache-pointArray.<object>Promisestring | Array.<string>stringbooleanstringstringstringstringbooleanstringbooleanstringbooleanstringstringstringcache-pointThe cache-point instance used when cache: true is specified on .explain() or .explainSync().
Kind: static property of jsdoc-api
Array.<object>Returns jsdoc explain output.
Kind: static method of jsdoc-api
Prerequisite: Requires node v0.12 or above
| Param | Type |
|---|---|
| [options] | JsdocOptions |
PromiseReturns a promise for the jsdoc explain output.
Kind: static method of jsdoc-api
Fulfil: object[] - jsdoc explain output
| Param | Type |
|---|---|
| [options] | JsdocOptions |
Render jsdoc documentation.
Kind: static method of jsdoc-api
Prerequisite: Requires node v0.12 or above
| Param | Type |
|---|---|
| [options] | JsdocOptions |
Example
jsdoc.renderSync({ files: 'lib/*', destination: 'api-docs' })
The jsdoc options, common for all operations.
Kind: inner class of jsdoc-api
string | Array.<string>stringbooleanstringstringstringstringbooleanstringbooleanstringbooleanstringstringstringstring | Array.<string>One or more filenames to process. Either this or source must be supplied.
Kind: instance property of JsdocOptions
stringA string containing source code to process. Either this or files must be supplied.
Kind: instance property of JsdocOptions
booleanSet to true to cache the output - future invocations with the same input will return immediately.
Kind: instance property of JsdocOptions
stringOnly display symbols with the given access: "public", "protected", "private" or "undefined", or "all" for all access levels. Default: all except "private".
Kind: instance property of JsdocOptions
stringThe path to the configuration file. Default: path/to/jsdoc/conf.json.
Kind: instance property of JsdocOptions
stringThe path to the output folder. Use "console" to dump data to the console. Default: ./out/.
Kind: instance property of JsdocOptions
stringAssume this encoding when reading all source files. Default: utf8.
Kind: instance property of JsdocOptions
booleanDisplay symbols marked with the @private tag. Equivalent to "--access all". Default: false.
Kind: instance property of JsdocOptions
stringThe path to the project's package file. Default: path/to/sourcefiles/package.json
Kind: instance property of JsdocOptions
booleanTreat errors as fatal errors, and treat warnings as errors. Default: false.
Kind: instance property of JsdocOptions
stringA query string to parse and store in jsdoc.env.opts.query. Example: foo=bar&baz=true.
Kind: instance property of JsdocOptions
booleanRecurse into subdirectories when scanning for source files and tutorials.
Kind: instance property of JsdocOptions
stringThe path to the project's README file. Default: path/to/sourcefiles/README.md.
Kind: instance property of JsdocOptions
stringThe path to the template to use. Default: path/to/jsdoc/templates/default.
Kind: instance property of JsdocOptions
stringDirectory in which JSDoc should search for tutorials.
Kind: instance property of JsdocOptions
© 2015-23 Lloyd Brookes <75pound@gmail.com>.
Tested by test-runner. Documented by jsdoc-to-markdown.
FAQs
Unknown package
The npm package jsdoc-api receives a total of 136,154 weekly downloads. As such, jsdoc-api popularity was classified as popular.
We found that jsdoc-api demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers unpack a typosquatting package with malicious code that logs keystrokes and exfiltrates sensitive data to a remote server.
Security News
The JavaScript community has launched the e18e initiative to improve ecosystem performance by cleaning up dependency trees, speeding up critical parts of the ecosystem, and documenting lighter alternatives to established tools.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.